---
sidebar_position: 4
toc_min_heading_level: 2
toc_max_heading_level: 2
---

# checkFriend

## 功能介绍

:::info 说明

检测好友关系，判断是否在已登录用户的好友列表中

:::

:::caution 注意

由于好友关系是双向关系，仅检测对方是否在自己的好友列表中，并不能检测自己是否在对方的好友列表中

:::

<Tabs
groupId="sdks-language"
values={[
{ label: 'iOS', value: 'iOS', },
{ label: 'Android', value: 'Android', },
{ label: 'Flutter', value: 'Flutter', },
{ label: 'Uniapp', value: 'Uniapp', },
{ label: 'Web', value: 'Web', },
]
}>

<TabItem value="Flutter">

### 函数原型

```dart showLineNumbers
 Future<List<FriendshipInfo>> checkFriend({
    required List<String> uidList,
    String? operationID,
  })
```

### 输入参数

| 参数名称 | 参数类型      | 是否必填 | 描述         |
| -------- | ------------- | -------- | ------------ |
| uidList  | List<String\> | 是       | 用户 ID 列表 |

### 返回结果

| 参数名称 | 参数类型                                                          | 描述     |
| -------- | ----------------------------------------------------------------- | -------- |
| ~        | List<[FriendshipInfo](docs/sdks/Class/Friend/FriendshipInfo.mdx)> | 成功返回 |

### 代码示例

```dart showLineNumbers
   final list = await OpenIM.iMManager.friendshipManager.checkFriend(uidList: ['id']);
```

</TabItem>

<TabItem value="iOS">

### 函数原型

```swift showLineNumbers

- (void)checkFriend:(NSArray <NSString *> *)usersID
          onSuccess:(nullable OIMSimpleResultsCallback)onSuccess
          onFailure:(nullable OIMFailureCallback)onFailure;

```

### 输入参数

| 参数名称 | 参数类型              | 是否必填 | 描述         |
| -------- | --------------------- | -------- | ------------ |
| usersID  | NSArray <NSString \*> | 是       | 用户 ID 列表 |

### 返回结果

| 参数名称  | 参数类型                                             | 描述     |
| --------- | ---------------------------------------------------- | -------- |
| onSuccess | NSArray<OIMSimpleResultInfo \*>                      | 成功返回 |
| onFailure | [OIMFailureCallback](docs/sdks/Callback/onError.mdx) | 失败返回 |

### 代码示例

```swift showLineNumbers

[OIMManager.manager checkFriend:@[]
                              onSuccess:^(NSArray<OIMSimpleResultInfo *> * _Nullable results) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

```

</TabItem>

<TabItem value="Android">

### 函数原型

```java showLineNumbers

public void checkFriend(OnBase<List<FriendshipInfo>> base, List<String> uidList)

```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述    |
| -------- | -------- | -------- | ------- |
| callBack   | [OnBase](docs/sdks/Callback/onBase.mdx) | 是       |  回调接口|
| uid   | String | 是       | 用户 ID |

### 返回结果


### 代码示例

```java showLineNumbers

OpenIMClient.getInstance().friendshipManager.addBlacklist(new OnBase<String>{...},uid)

```


</TabItem>

<TabItem value="Web">

### 参数详解

</TabItem>

<TabItem value="Uniapp">

### 参数详解

| 参数名称    | 参数类型 | 是否必填 | 描述                                 |
| ----------- | -------- | -------- | ------------------------------------ | --- |
| operationID | string   | 是       | 唯一随机字符串，用于根据日志定位问题 |
| userID      | string   | 是       | IM 用户 userID                       |
| token       | string   | 是       | IM 用户 token                        |     |

### 返回模板

```
Promise<void>
```

### 代码示例

```js showLineNumbers
import IMSDK from '@openim-sdk/uniapp-polyfill';

await IMSDK.API.login(IMSDK.uuidv4(), userID, token);
```

</TabItem>

</Tabs>
